clipboardy

What is clipboardy?

The clipboardy npm package allows for copying to and pasting from the system clipboard in Node.js applications. It provides a simple interface to interact with the clipboard on different operating systems.

What are clipboardy's main functionalities?

Copy text to clipboard

This feature allows you to copy text to the system clipboard. The `writeSync` method is used to synchronously write text to the clipboard.

const clipboardy = require('clipboardy');
clipboardy.writeSync('Text to copy');

Paste text from clipboard

This feature allows you to paste text from the system clipboard. The `readSync` method is used to synchronously read text from the clipboard and store it in a variable.

const clipboardy = require('clipboardy');
let text = clipboardy.readSync();
console.log(text);

Copy text to clipboard asynchronously

This feature allows you to copy text to the clipboard asynchronously. The `write` method returns a promise that resolves when the text has been copied.

const clipboardy = require('clipboardy');
clipboardy.write('Text to copy').then(() => {
  console.log('Text copied!');
}).catch(err => {
  console.error('Failed to copy text:', err);
});

Paste text from clipboard asynchronously

This feature allows you to paste text from the clipboard asynchronously. The `read` method returns a promise that resolves with the text from the clipboard.

const clipboardy = require('clipboardy');
clipboardy.read().then(text => {
  console.log('Pasted text:', text);
}).catch(err => {
  console.error('Failed to paste text:', err);
});

Other packages similar to clipboardy

clipboard

The 'clipboard' package is a cross-platform clipboard API for the web. It allows for copying and pasting text within web applications but is not suitable for Node.js server-side applications. It differs from clipboardy in that it is designed for use in the browser rather than in Node.js environments.

copy-paste

The 'copy-paste' package is another Node.js module that provides copy and paste functionality. It is similar to clipboardy but has not been maintained as actively. It may not support as many platforms or have as robust error handling as clipboardy.

clipboard-cli

The 'clipboard-cli' package is a command-line interface for copying and pasting text using the system clipboard. It is built on top of clipboardy and offers a CLI rather than a programmatic API. It is useful for scripting and command-line tasks but not for integrating clipboard functionality into Node.js applications.

README

clipboardy

Access the system clipboard (copy/paste)

Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with Termux, and modern browsers.

Install

npm install clipboardy

Usage

import clipboard from 'clipboardy';

clipboard.writeSync('🦄');

clipboard.readSync();
//=> '🦄'

API

In the browser, it requires a secure context.

clipboard

.write(text)

Write (copy) to the clipboard asynchronously.

Returns a Promise.

text

Type: string

The text to write to the clipboard.

.read()

Read (paste) from the clipboard asynchronously.

Returns a Promise.

.writeSync(text)

Write (copy) to the clipboard synchronously.

Doesn't work in browsers.

text

Type: string

The text to write to the clipboard.

.readSync()

Read (paste) from the clipboard synchronously.

Doesn't work in browsers.

FAQ

Where can I find the source of the bundled binaries?

The Linux binary is just a bundled version of xsel. The source for the Windows binary can be found here.

Related

• clipboard-cli - CLI for this module
• copy-text-to-clipboard - Copy text to the clipboard in the browser